Crate icu_pattern

icu_pattern is a utility crate of the ICU4X project.

It includes a Pattern type which supports patterns with various storage backends.

The types are tightly coupled with the writeable crate.

Examples

Parsing and interpolating with a single-placeholder pattern:

use icu_pattern::SinglePlaceholderPattern;
use writeable::assert_writeable_eq;

// Parse a pattern string:
let pattern = "Hello, {0}!"
    .parse::<SinglePlaceholderPattern<_>>()
    .unwrap();

// Interpolate into the pattern string:
assert_writeable_eq!(pattern.interpolate(["World"]), "Hello, World!");

// Introspect the serialized form of the pattern string:
assert_eq!(pattern.take_store(), "\x08Hello, !");

Re-exports

• pub use PatternError as Error;

Structs

• MissingNamedPlaceholderError
• MultiNamedPlaceholderKey
  A string wrapper for the MultiNamedPlaceholder pattern backend.
• Parser
  Placeholder pattern parser.
• ParserOptions
  Options passed to the constructor of Parser.
• Pattern
  A string pattern with placeholders.

Enums

• DoublePlaceholder
  Backend for patterns containing zero, one, or two placeholders.
• DoublePlaceholderKey
  A two-value enum for the DoublePlaceholder pattern backend.
• MultiNamedPlaceholder
  Backend for patterns containing zero or more named placeholders.
• ParsedPatternItem
  A PatternItem with additional detail returned by the Parser.
• ParserError
  An error returned when parsing a pattern.
• PatternError
• PatternItem
  A borrowed item in a Pattern. Items are either string literals or placeholders.
• PatternItemCow
  A borrowed-or-owned item in a Pattern. Items are either string literals or placeholders.
• SinglePlaceholder
  Backend for patterns containing zero or one placeholder.
• SinglePlaceholderKey
  A singleton enum for the SinglePlaceholder pattern backend.

Constants

• PATTERN_LITERAL_PART
  Default annotation for the literal portion of a pattern.
• PATTERN_PLACEHOLDER_PART
  Default annotation for the placeholder portion of a pattern.

Traits

• PatternBackend
  Types that implement backing data models for Pattern implement this trait.
• PlaceholderValueProvider
  Trait implemented on collections that can produce TryWriteables for interpolation.

Type Aliases

• DoublePlaceholderPattern
  Examples
• MultiNamedPlaceholderPattern
  Examples
• SinglePlaceholderPattern
  Examples